/*
 * Funambol is a mobile platform developed by Funambol, Inc. 
 * Copyright (C) 2008 Funambol, Inc.
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by
 * the Free Software Foundation with the addition of the following permission 
 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
 * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Affero General Public License 
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA.
 * 
 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
 * 
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 * 
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Powered by Funambol" logo. If the display of the logo is not reasonably 
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Powered by Funambol".
 */

#ifndef INCL_SQL_DRIVER
#define INCL_SQL_DRIVER

#include "base/util/StringBuffer.h"
#include "base/util/ArrayList.h"

using namespace Funambol;


/**
 * A generic SQLDriver class that contains the common method that must be implemented
 * by every specific SQL driver.
 */
 
class SQLDriver {

private:    

public:

    /**
    * Constructor. It should have some initializer? maybe the path to the db, user/passwd?...
    */
    // SQLDriver(); 
    
    virtual ~SQLDriver();

    /**
    * Connect to the database server.  The connection should be stored
    * within the subclass and destroyed in disconnect();  If connect is called
    * while a connection exists, nothing should happen.
    *
    * @return      - 0 success, error otherwise
    */
    virtual int connect() = 0; 

    /**
    * Disconnect from the database server.  If the connection is not open,
    * do nothing.
    *
    * @return      - 0 success, error otherwise
    */
    virtual int disconnect() = 0;

    /**
    * Execute the query passed as param. Mostrly used for action like insert and update.
    *
    * @param const char* the query to execute
    *
    * @return      - 0 success, error otherwise
    */
    virtual int execute(const char* statement);

    /**
    * Make a query to search only the indexes on a table.
    * The query should be a SELECT that look for all the Id in the table 
    * that satisfies the query consition. It could be useful to retrieve the modified
    * items   
    *
    * @param query - the statement to be executed (most of all a select)
    * @param result - an ArrayList of StringBuffer the method fills with results of the query
    *
    * @return      - 0 success, error otherwise
    */ 
    virtual int queryIndex(const char* query, ArrayList& result); 
    
    /**
    * It is used to commit the operation in the db. If autocommit is false 
    * this has to be implemented
    *
    * @return - 0success, error otherwise
    */
    virtual int commit();
};
#endif
